PayPal決済利用承諾 API一覧

PayPal決済　利用承諾 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranPaypal 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
JobCd		必須半角英字8桁処理区分 REGISTER：申込
Amount		必須半角数字10桁利用金額「0」を設定します。

URL

/payment/EntryTranPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=REGISTER&Amount=0

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranPaypal 決済実行

PayPalと通信を行い決済要求結果を返します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ItemName		必須全半角記号64桁商品・サービス名
RedirectURL		必須半角英数記号200桁リダイレクトURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを指定します。 PayPal上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果を送信します。結果はリダイレクト経由で送信します。
Locale		半角英字2桁言語 PayPal決済画面上に表示する言語を選択します。無指定の場合、日本語が表示されます。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
ClientFieldFlag		半角数字1桁固定加盟店自由項目返却フラグ以下のいずれかを設定します。 0：返却しない(デフォルト) 1：返却する

URL

/payment/ExecTranPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ItemName=商品名&RedirectURL=https://example.com/receive

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypalStart 支払手続き開始

お客様をPayPalの認証画面へと遷移させる必要があります。
加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは各種パラメータを設定し、お客様をPayPalの認証画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

ShopID		必須半角英数13桁ショップID
AccessID		必須半角英数32桁固定取引ID

URL

/payment/PaypalStart.idPass

リダイレクトページサンプル

<html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
      </head>
      <body OnLoad='OnLoadEvent();'>
      <form name="PaypalStartCall" action="{支払手続き開始URL}" method="POST">
        <noscript>
          <br>
          <br>
          <center>
            <h2>PayPalの決済画面へ遷移します。</h2>
            <input type="submit" value="続行">
          </center>
        </noscript>
        <input type="hidden" name="ShopID" value="{ShopID}">
        <input type="hidden" name="AccessID" value="{AccessID}">
      </form>
      <script>
    <!--
    function OnLoadEvent() {
    document.PaypalStartCall.submit();
    }
    //-->
      </script>
      </body>
    </html>

リダイレクト後、お客様はPayPalログイン画面へ遷移します。

決済結果受信

PayPalセンターからリダイレクト経由で、当サービスに支払操作結果が通知されます。

レスポンス

正常

ShopID		半角英数13桁ショップID
OrderID		半角英数記号27桁オーダーID
Status		現状態該当取引の取引状態を返却します。・REGISTER：申込・PAYFAIL：決済失敗
PaypalBillingAgreementID		半角英数記号19桁支払同意ID PayPalから返却された支払同意IDを返却します。
AgreementCurrentstatus		半角英字8桁利用承諾現状態利用承諾の現状態を返却します。・REGISTER：利用承諾・FAIL：申込失敗

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=REGISTER&PaypalBillingAgreementID=B-53G467521V0468537&AgreementCurrentstatus=REGISTER

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypalAcceptEnd 利用承諾終了

指定した支払同意IDの利用を終了することが可能です。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
PaypalBillingAgreementID		必須半角英数記号19桁支払同意ID 終了させたい利用承諾の支払同意IDを設定します。

URL

/payment/PaypalAcceptEnd.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaypalBillingAgreementID=B-53G467521V0468537

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		半角英字3桁現状態対象取引の取引状態を返却します。　・END：終了

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=END

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字2桁決済方法 5：PayPal決済

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=5

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 REGISTER：利用承諾 END：利用終了 PAYFAIL：決済失敗 EXPIRED：期限切れ
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		処理区分 REGISTER：利用承諾 END：利用終了
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
Currency		半角英字3桁通貨コード
TranID		半角英数28桁トランザクションID nullで返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 5：PayPal
PaypalPaymentType		決済タイプ nullで返却します。
PaypalAgreementCurrentstatus		利用承諾現状態利用承諾の現状態を返却します。 UNPROCESSED：未決済 REQSUCCESS：要求成功 REGISTER：利用承諾 END：利用終了 FAIL：申込失敗
PaypalAgreementID		半角英数記号19桁支払同意ID PayPalから返却された支払同意IDを返却します。
PaypalBillingAgreementID		半角英数記号19桁随時決済用支払同意ID nullで返却します。
PaypalAgreementStartDate		半角数字14桁固定利用承諾日付 yyyyMMddHHmmss書式
PaypalAgreementEndDate		半角数字14桁固定利用終了日付 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=REGISTER&ProcessDate=20201225091313&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=0&Tax=0&Currency=JPY&TranID=&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=5&PaypalPaymentType=&PaypalAgreementCurrentstatus=REGISTER&PaypalAgreementID=B-1YL66913SV546823C&PaypalBillingAgreementID=&PaypalAgreementStartDate=20201225091313&PaypalAgreementEndDate=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PayPal決済